home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / zgelss.z / zgelss
Text File  |  1996-03-14  |  4KB  |  133 lines
  1.  
  2.  
  3.  
  4. ZZZZGGGGEEEELLLLSSSSSSSS((((3333FFFF))))                                                          ZZZZGGGGEEEELLLLSSSSSSSS((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      ZGELSS - compute the minimum norm solution to a complex linear least
  10.      squares problem
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE ZGELSS( M, N, NRHS, A, LDA, B, LDB, S, RCOND, RANK, WORK,
  14.                         LWORK, RWORK, INFO )
  15.  
  16.          INTEGER        INFO, LDA, LDB, LWORK, M, N, NRHS, RANK
  17.  
  18.          DOUBLE         PRECISION RCOND
  19.  
  20.          DOUBLE         PRECISION RWORK( * ), S( * )
  21.  
  22.          COMPLEX*16     A( LDA, * ), B( LDB, * ), WORK( * )
  23.  
  24. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  25.      ZGELSS computes the minimum norm solution to a complex linear least
  26.      squares problem:
  27.  
  28.      Minimize 2-norm(| b - A*x |).
  29.  
  30.      using the singular value decomposition (SVD) of A. A is an M-by-N matrix
  31.      which may be rank-deficient.
  32.  
  33.      Several right hand side vectors b and solution vectors x can be handled
  34.      in a single call; they are stored as the columns of the M-by-NRHS right
  35.      hand side matrix B and the N-by-NRHS solution matrix X.
  36.  
  37.      The effective rank of A is determined by treating as zero those singular
  38.      values which are less than RCOND times the largest singular value.
  39.  
  40.  
  41. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  42.      M       (input) INTEGER
  43.              The number of rows of the matrix A. M >= 0.
  44.  
  45.      N       (input) INTEGER
  46.              The number of columns of the matrix A. N >= 0.
  47.  
  48.      NRHS    (input) INTEGER
  49.              The number of right hand sides, i.e., the number of columns of
  50.              the matrices B and X. NRHS >= 0.
  51.  
  52.      A       (input/output) COMPLEX*16 array, dimension (LDA,N)
  53.              On entry, the M-by-N matrix A.  On exit, the first min(m,n) rows
  54.              of A are overwritten with its right singular vectors, stored
  55.              rowwise.
  56.  
  57.      LDA     (input) INTEGER
  58.              The leading dimension of the array A. LDA >= max(1,M).
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZZZZGGGGEEEELLLLSSSSSSSS((((3333FFFF))))                                                          ZZZZGGGGEEEELLLLSSSSSSSS((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      B       (input/output) COMPLEX*16 array, dimension (LDB,NRHS)
  75.              On entry, the M-by-NRHS right hand side matrix B.  On exit, B is
  76.              overwritten by the N-by-NRHS solution matrix X.  If m >= n and
  77.              RANK = n, the residual sum-of-squares for the solution in the i-
  78.              th column is given by the sum of squares of elements n+1:m in
  79.              that column.
  80.  
  81.      LDB     (input) INTEGER
  82.              The leading dimension of the array B.  LDB >= max(1,M,N).
  83.  
  84.      S       (output) DOUBLE PRECISION array, dimension (min(M,N))
  85.              The singular values of A in decreasing order.  The condition
  86.              number of A in the 2-norm = S(1)/S(min(m,n)).
  87.  
  88.      RCOND   (input) DOUBLE PRECISION
  89.              RCOND is used to determine the effective rank of A.  Singular
  90.              values S(i) <= RCOND*S(1) are treated as zero.  If RCOND < 0,
  91.              machine precision is used instead.
  92.  
  93.      RANK    (output) INTEGER
  94.              The effective rank of A, i.e., the number of singular values
  95.              which are greater than RCOND*S(1).
  96.  
  97.      WORK    (workspace/output) COMPLEX*16 array, dimension (LWORK)
  98.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  99.  
  100.      LWORK   (input) INTEGER
  101.              The dimension of the array WORK. LWORK >= 1, and also:  LWORK >=
  102.              2*min(M,N) + max(M,N,NRHS) For good performance, LWORK should
  103.              generally be larger.
  104.  
  105.      RWORK   (workspace) DOUBLE PRECISION array, dimension (5*min(M,N)-1)
  106.  
  107.      INFO    (output) INTEGER
  108.              = 0:  successful exit
  109.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  110.              > 0:  the algorithm for computing the SVD failed to converge; if
  111.              INFO = i, i off-diagonal elements of an intermediate bidiagonal
  112.              form did not converge to zero.
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.